AudioChannel

  1. Home
  2. Documentation
  3. Scripting
  4. AudioChannel

AudioChannel description ...

Properties

ID

int ID

Gets the Channel ID of this audio channel.

IsPlaying

bool IsPlaying

Gets whether this audio channel is currently playing a sound. Returns true if it is, or false if it is not.

LengthMs

int LengthMs

Gets the length of the audio playing on this channel, in milliseconds.

Panning

int Panning

Gets/sets the panning of this audio channel.

PlayingClip

AudioClip PlayingClip

Gets the audio clip that is playing on this channel.

Position

int Position

Gets the current position of the audio playing on this channel.

PositionMs

int PositionMs

Gets the current position of the audio playing on this channel, in milliseconds.

Speed

int Speed

Gets/sets the playing audio clip's playback speed. The value is defined in clip's milliseconds per second

Volume

int Volume

Gets/sets the volume of this audio channel, from 0 to 100. This allows you to dynamically adjust the volume of a playing sound.

Methods

Pause

void Pause()

Pauses the audio clip that is currently playing on this audio channel.

Resume

void Resume()

Resumes the audio clip that is currently playing on this audio channel.

Seek

Seeks the audio clip that is currently playing on this channel to position.

SetRoomLocation

Sets the currently playing audio to be a directional sound, eminating from (x,y).

Stop

void Stop()

Stops the sound that is currently playing on this audio channel.